Crear una definición de API web

Las definiciones de API web contienen todos los datos necesarios para indicar a Blue Prism cómo realizar solicitudes HTTP a una API web. Los datos en la definición de API determinan cómo se construye cada solicitud, especificando la URL, el método HTTP, los encabezados y la autenticación requeridos para realizar una solicitud. Las definiciones de API también permiten definir parámetros que pueden utilizarse para pasar datos a una solicitud.

Cada definición de API está compuesta por los siguientes elementos:

  • Configuración básica: el nombre, la URL base y la configuración de tiempo de espera utilizados para todas las solicitudes de API configuradas en la definición de API.
  • Acciones: las capacidades que ofrece la API web que se pondrán a disposición de Blue Prism. Las acciones detallan el cuerpo de la solicitud y el manejo de la respuesta para cada solicitud de API en la definición.
  • Encabezados HTTP: los encabezados que se utilizarán en las solicitudes para esta definición de API. Los encabezados comunes se utilizan en todas las solicitudes y los encabezados específicos de la acción se utilizan, además de cualquier encabezado común, para las acciones en las que se definen.
  • Parámetros: las referencias de expansión dinámica que se utilizan para pasar datos a URL de base, rutas de URL, encabezados y cuerpos de solicitud. Los parámetros también se pueden utilizar en el campo Asunto para las configuraciones de OAuth 2.0 (ficha de portador JWT). Los parámetros comunes se pueden utilizar en cualquier acción, los parámetros específicos de la acción solo se pueden utilizar en la acción en la que se definen.
  • Autenticación común: cómo se autentica cada solicitud a una API.
  • Código común: código utilizado para crear solicitudes y respuestas de API complejas.

Las definiciones de API web se configuran en la configuración del sistema del cliente interactivo de Blue Prism.

  1. Seleccione la pestaña System (Sistema).
  2. Seleccione Objetos > Servicios de API web en el árbol de navegación.

  3. Haga clic en Agregar variable en el menú de opciones.

    Aparece el cuadro de diálogo Nuevo servicio de API web.